Bentley Automation Service Help

Add Symbol Dialog

This dialog is used to insert ProjectWise and/or system variables when defining naming patterns/conventions for folder and file names, and opens when you click the Add Symbol button on the following dialogs:

  • the Naming Convention Profile dialogs that open from the (i-model publishing) Options dialog
  • the Output Destination Profile dialogs that open from the iCS for i-models tab of the Job Builder

When the Add Symbol dialog opens, select a category of properties on the left, then select a specific property variable on the right, then click OK.

Note: Not all of the property variables belonging to the selected category are exposed.

The following categories are available:

  • Document
  • File Extension
  • Folder
  • Work Area
  • Environment
  • General
  • Transform
Note: When a date or time variable is selected, a Format list displays below the list of variables for you to select which date or time format to use when the variable is replaced with a real value. For example, <Date?format=ddMMMMyyyy> or <Time?format=HHmm>

Document Category

The following document property variables are provided:

Variable Name Variable Description
Base Description <Document.BaseDescription> Inserts the document's description (without the extension, if there is one).
Base File Name <Document.BaseFileName> Inserts the file name (without the file name extension, if there is one).
Base Name <Document.BaseName> Inserts the name of the original document (without the file extension, if there is one).
Department <Document.Department> Inserts the document's department.
Description <Document.Description> Inserts the document's description.
File Name <Document.FileName> Inserts the file name.
Doc ID <Document.ID> Inserts the document's ID number within the folder. For example, if the selected document is the second file placed in a folder, this field displays the numeral "2".
Doc GUID <Document.Guid> Insert's the document's GUID.
Name <Document.Name> Inserts the name of the original document.
Sequence <Document.Sequence> Inserts the document's version sequence number. For example, if the selected document is the original version of the document, this field displays the numeral "0".
State <Document.State> Inserts the document's state.
State Description <Document.StateDescription> Inserts the document's state description.
Version <Document.Version> Inserts the document's version.
Workflow <Document.Workflow> Inserts the document's workflow.
Workflow Description <Document.WorkflowDescription> Inserts the document's workflow description.

File Extension Category

The following file extension property variables are provided:

Variable Name Variable Description
source file extension <Extension.SrcFileExt> Inserts the source file's extension.
.i.dgn extension <Extension.IDGNExt> Inserts the package file extension, .i.dgn.
.imodel extension <Extension.IModelExt> Inserts the i-model file extension, imodel.
.x.dgn extention <Extension.XDGNExt> Inserts the extension .x.dgn, to designate that it is a DGN file that was derived from a package (.i.dgn).

Folder Category

The following folder property variables are provided:

Variable Name Variable Description
Description <Folder.Description> Inserts the folder's description.
Environment <Folder.Environment> Inserts the folder's environment.
Folder ID <Folder.ID> Inserts the folder's ID number within its parent folder.
Folder GUID <Folder.Guid> Insert's the folder's GUID.
Name <Folder.Name> Inserts the folder's name.

Work Area Category

When the Work Area category is selected, a Name list displays for you to select from the available work area types in the datasource. When you select a work area type, the work area properties available in the selected work area type are displayed in the variables list.

Environment Category

When the Environment category is selected, a Name list displays for you to select from the available environments in the datasource. When you select an environment, the attributes available in the selected environment are displayed in the variables list.

General Category

The following general property variables are provided:

Variable Name Variable Description
Date <Date> Inserts the current date.
Time <Time> Inserts the current time.
User Description <UserDescription> Inserts the user description of the ProjectWise user account.
User Name <UserName> Inserts the user name of the ProjectWise user account.

Transform Category

The following transform property variables are provided:

Variable Name Variable Description
Transform Display Name <Transform.DisplayName> Inserts the display name of the transform.
Transform Type <Transform.Type> Inserts the type of transform used.
Transform Script Name <Transform.ScriptName> Inserts the script name used by the transform.